/*
 * Licensed to Crate under one or more contributor license agreements.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.  Crate licenses this file
 * to you under the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.  You may
 * obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied.  See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * However, if you have executed another commercial license agreement
 * with Crate these terms will supersede the license and you may use the
 * software solely pursuant to the terms of the relevant commercial
 * agreement.
 */

package io.crate.execution.engine.sort;

import io.crate.analyze.OrderBy;
import io.crate.execution.engine.collect.DocInputFactory;
import io.crate.expression.reference.doc.lucene.CollectorContext;
import io.crate.lucene.FieldTypeLookup;
import io.crate.metadata.TransactionContext;
import org.apache.lucene.search.Sort;
import org.apache.lucene.search.SortField;

import javax.annotation.Nullable;

public class LuceneSortGenerator {

    @Nullable
    public static Sort generateLuceneSort(TransactionContext txnCtx,
                                          CollectorContext context,
                                          OrderBy orderBy,
                                          DocInputFactory docInputFactory,
                                          FieldTypeLookup fieldTypeLookup) {
        if (orderBy.orderBySymbols().isEmpty()) {
            return null;
        }
        SortSymbolVisitor sortSymbolVisitor = new SortSymbolVisitor(docInputFactory, fieldTypeLookup);
        SortField[] sortFields = sortSymbolVisitor.generateSortFields(
            orderBy.orderBySymbols(),
            txnCtx,
            context,
            orderBy.reverseFlags(),
            orderBy.nullsFirst()
        );
        return new Sort(sortFields);
    }
}
